<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>v_hdmirxss: si5324drv.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">v_hdmirxss
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('si5324drv_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">si5324drv.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains definitions for low-level driver functions for controlling the SiliconLabs Si5324 clock generator as mounted on the KC705 demo board. </p>
<p>The user should refer to the hardware device specification for more details of the device operation.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date        Changes
<hr/>

1.00  hf  2014/10/10   First release
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:aba0c6a06cbada8a7b750be6ff0695a47"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#aba0c6a06cbada8a7b750be6ff0695a47">SI5324_XTAL_FREQ</a>&#160;&#160;&#160;114285000</td></tr>
<tr class="memdesc:aba0c6a06cbada8a7b750be6ff0695a47"><td class="mdescLeft">&#160;</td><td class="mdescRight">The frequency of the crystal connected to the XA/XB pins of the Si5324 in Hz.  <a href="#aba0c6a06cbada8a7b750be6ff0695a47">More...</a><br /></td></tr>
<tr class="separator:aba0c6a06cbada8a7b750be6ff0695a47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7a50734f0226414ddcb1e1c30815f20"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#aa7a50734f0226414ddcb1e1c30815f20">SI5324_DEBUG</a>&#160;&#160;&#160;FALSE</td></tr>
<tr class="memdesc:aa7a50734f0226414ddcb1e1c30815f20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Debug output enable.  <a href="#aa7a50734f0226414ddcb1e1c30815f20">More...</a><br /></td></tr>
<tr class="separator:aa7a50734f0226414ddcb1e1c30815f20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab111a2a2d52eb8e3366d8c5723a186a8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#ab111a2a2d52eb8e3366d8c5723a186a8">SI5324_SUCCESS</a>&#160;&#160;&#160;0</td></tr>
<tr class="memdesc:ab111a2a2d52eb8e3366d8c5723a186a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The following constants are error codes generated by the functions in this driver.  <a href="#ab111a2a2d52eb8e3366d8c5723a186a8">More...</a><br /></td></tr>
<tr class="separator:ab111a2a2d52eb8e3366d8c5723a186a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ede2c0617ef9093ee69e3c5a01199f8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a9ede2c0617ef9093ee69e3c5a01199f8">SI5324_ERR_IIC</a>&#160;&#160;&#160;-1</td></tr>
<tr class="memdesc:a9ede2c0617ef9093ee69e3c5a01199f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">IIC error occurred.  <a href="#a9ede2c0617ef9093ee69e3c5a01199f8">More...</a><br /></td></tr>
<tr class="separator:a9ede2c0617ef9093ee69e3c5a01199f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e4d865d04b23e830daa8be2e35a0922"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a8e4d865d04b23e830daa8be2e35a0922">SI5324_ERR_FREQ</a>&#160;&#160;&#160;-2</td></tr>
<tr class="memdesc:a8e4d865d04b23e830daa8be2e35a0922"><td class="mdescLeft">&#160;</td><td class="mdescRight">Could not calculate frequency setting.  <a href="#a8e4d865d04b23e830daa8be2e35a0922">More...</a><br /></td></tr>
<tr class="separator:a8e4d865d04b23e830daa8be2e35a0922"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fa75e494c0f242ce3a8d43680ec5b25"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a5fa75e494c0f242ce3a8d43680ec5b25">SI5324_ERR_PARM</a>&#160;&#160;&#160;-3</td></tr>
<tr class="memdesc:a5fa75e494c0f242ce3a8d43680ec5b25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invalid parameter.  <a href="#a5fa75e494c0f242ce3a8d43680ec5b25">More...</a><br /></td></tr>
<tr class="separator:a5fa75e494c0f242ce3a8d43680ec5b25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2db6980ae01d5ddad9a49d3251516feb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a2db6980ae01d5ddad9a49d3251516feb">SI5324_CLKSRC_CLK1</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:a2db6980ae01d5ddad9a49d3251516feb"><td class="mdescLeft">&#160;</td><td class="mdescRight">The following constants define the clock input select values.  <a href="#a2db6980ae01d5ddad9a49d3251516feb">More...</a><br /></td></tr>
<tr class="separator:a2db6980ae01d5ddad9a49d3251516feb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02493d2265012108f5e0d4b80b199c76"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a02493d2265012108f5e0d4b80b199c76">SI5324_CLKSRC_CLK2</a>&#160;&#160;&#160;2</td></tr>
<tr class="memdesc:a02493d2265012108f5e0d4b80b199c76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use clock input 2.  <a href="#a02493d2265012108f5e0d4b80b199c76">More...</a><br /></td></tr>
<tr class="separator:a02493d2265012108f5e0d4b80b199c76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1d51e9b1e4b660eee4ec41222751c1e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#aa1d51e9b1e4b660eee4ec41222751c1e">SI5324_CLKSRC_XTAL</a>&#160;&#160;&#160;3</td></tr>
<tr class="memdesc:aa1d51e9b1e4b660eee4ec41222751c1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use crystal (free running mode)  <a href="#aa1d51e9b1e4b660eee4ec41222751c1e">More...</a><br /></td></tr>
<tr class="separator:aa1d51e9b1e4b660eee4ec41222751c1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8adf10a1b80feb2992f6b971cdd28271"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a8adf10a1b80feb2992f6b971cdd28271">SI5324_FOSC_MIN</a>&#160;&#160;&#160;4850000000</td></tr>
<tr class="memdesc:a8adf10a1b80feb2992f6b971cdd28271"><td class="mdescLeft">&#160;</td><td class="mdescRight">The following constants define the limits of the Si5324 frequencies.  <a href="#a8adf10a1b80feb2992f6b971cdd28271">More...</a><br /></td></tr>
<tr class="separator:a8adf10a1b80feb2992f6b971cdd28271"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0883e98bf3d4a3ce4e051b598212fe1e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a0883e98bf3d4a3ce4e051b598212fe1e">SI5324_FOSC_MAX</a>&#160;&#160;&#160;5670000000</td></tr>
<tr class="memdesc:a0883e98bf3d4a3ce4e051b598212fe1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum oscillator frequency.  <a href="#a0883e98bf3d4a3ce4e051b598212fe1e">More...</a><br /></td></tr>
<tr class="separator:a0883e98bf3d4a3ce4e051b598212fe1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a228ebaa351cbbfc0f6c5c94554d7ca4e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a228ebaa351cbbfc0f6c5c94554d7ca4e">SI5324_F3_MAX</a>&#160;&#160;&#160;2000000</td></tr>
<tr class="memdesc:a228ebaa351cbbfc0f6c5c94554d7ca4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum phase detector frequency.  <a href="#a228ebaa351cbbfc0f6c5c94554d7ca4e">More...</a><br /></td></tr>
<tr class="separator:a228ebaa351cbbfc0f6c5c94554d7ca4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81ac3490c0ed20fabfa1b71584eac04b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a81ac3490c0ed20fabfa1b71584eac04b">SI5324_FIN_MIN</a>&#160;&#160;&#160;2000</td></tr>
<tr class="memdesc:a81ac3490c0ed20fabfa1b71584eac04b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum input frequency.  <a href="#a81ac3490c0ed20fabfa1b71584eac04b">More...</a><br /></td></tr>
<tr class="separator:a81ac3490c0ed20fabfa1b71584eac04b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa37b2b306f750c592c636849367b5987"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#aa37b2b306f750c592c636849367b5987">SI5324_FIN_MAX</a>&#160;&#160;&#160;710000000</td></tr>
<tr class="memdesc:aa37b2b306f750c592c636849367b5987"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum input frequency.  <a href="#aa37b2b306f750c592c636849367b5987">More...</a><br /></td></tr>
<tr class="separator:aa37b2b306f750c592c636849367b5987"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6256033a0e61e3af40ff9d7cb420639"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#ad6256033a0e61e3af40ff9d7cb420639">SI5324_FOUT_MIN</a>&#160;&#160;&#160;2000</td></tr>
<tr class="memdesc:ad6256033a0e61e3af40ff9d7cb420639"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum output frequency.  <a href="#ad6256033a0e61e3af40ff9d7cb420639">More...</a><br /></td></tr>
<tr class="separator:ad6256033a0e61e3af40ff9d7cb420639"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6cb6ad9a6bdd28badfa7d4dbd404b89"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#ae6cb6ad9a6bdd28badfa7d4dbd404b89">SI5324_FOUT_MAX</a>&#160;&#160;&#160;945000000</td></tr>
<tr class="memdesc:ae6cb6ad9a6bdd28badfa7d4dbd404b89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum output frequency.  <a href="#ae6cb6ad9a6bdd28badfa7d4dbd404b89">More...</a><br /></td></tr>
<tr class="separator:ae6cb6ad9a6bdd28badfa7d4dbd404b89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d32f6e4587dbcf01bc3a2c2e91a2df7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a3d32f6e4587dbcf01bc3a2c2e91a2df7">SI5324_N1_HS_MIN</a>&#160;&#160;&#160;6</td></tr>
<tr class="memdesc:a3d32f6e4587dbcf01bc3a2c2e91a2df7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The following constants define the limits of the divider settings.  <a href="#a3d32f6e4587dbcf01bc3a2c2e91a2df7">More...</a><br /></td></tr>
<tr class="separator:a3d32f6e4587dbcf01bc3a2c2e91a2df7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca2c63c7a287455eff6d20da1772484e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#aca2c63c7a287455eff6d20da1772484e">SI5324_N1_HS_MAX</a>&#160;&#160;&#160;11</td></tr>
<tr class="memdesc:aca2c63c7a287455eff6d20da1772484e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum N1_HS setting.  <a href="#aca2c63c7a287455eff6d20da1772484e">More...</a><br /></td></tr>
<tr class="separator:aca2c63c7a287455eff6d20da1772484e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69fe20269cf003fdcf22f5fc1cd2769c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a69fe20269cf003fdcf22f5fc1cd2769c">SI5324_NC_LS_MIN</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:a69fe20269cf003fdcf22f5fc1cd2769c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum NCn_LS setting (1 and even values)  <a href="#a69fe20269cf003fdcf22f5fc1cd2769c">More...</a><br /></td></tr>
<tr class="separator:a69fe20269cf003fdcf22f5fc1cd2769c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1970bf7864d31f729e163d103a903075"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a1970bf7864d31f729e163d103a903075">SI5324_NC_LS_MAX</a>&#160;&#160;&#160;0x100000</td></tr>
<tr class="memdesc:a1970bf7864d31f729e163d103a903075"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum NCn_LS setting (1 and even values)  <a href="#a1970bf7864d31f729e163d103a903075">More...</a><br /></td></tr>
<tr class="separator:a1970bf7864d31f729e163d103a903075"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33d91ebd8ce05be9f823fc82e35a5d38"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a33d91ebd8ce05be9f823fc82e35a5d38">SI5324_N2_HS_MIN</a>&#160;&#160;&#160;4</td></tr>
<tr class="memdesc:a33d91ebd8ce05be9f823fc82e35a5d38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum NC2_HS setting.  <a href="#a33d91ebd8ce05be9f823fc82e35a5d38">More...</a><br /></td></tr>
<tr class="separator:a33d91ebd8ce05be9f823fc82e35a5d38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c09138972a1acb59eb46de878c97a3a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a8c09138972a1acb59eb46de878c97a3a">SI5324_N2_HS_MAX</a>&#160;&#160;&#160;11</td></tr>
<tr class="memdesc:a8c09138972a1acb59eb46de878c97a3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum NC2_HS setting.  <a href="#a8c09138972a1acb59eb46de878c97a3a">More...</a><br /></td></tr>
<tr class="separator:a8c09138972a1acb59eb46de878c97a3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59663975c6b419aae6b34f3ef265605e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a59663975c6b419aae6b34f3ef265605e">SI5324_N2_LS_MIN</a>&#160;&#160;&#160;2</td></tr>
<tr class="memdesc:a59663975c6b419aae6b34f3ef265605e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum NC2_LS setting (even values only)  <a href="#a59663975c6b419aae6b34f3ef265605e">More...</a><br /></td></tr>
<tr class="separator:a59663975c6b419aae6b34f3ef265605e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad9917dc2207eddbbe18ac7e14050133"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#aad9917dc2207eddbbe18ac7e14050133">SI5324_N2_LS_MAX</a>&#160;&#160;&#160;0x100000</td></tr>
<tr class="memdesc:aad9917dc2207eddbbe18ac7e14050133"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum NC2_LS setting (even values only)  <a href="#aad9917dc2207eddbbe18ac7e14050133">More...</a><br /></td></tr>
<tr class="separator:aad9917dc2207eddbbe18ac7e14050133"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af66f4eb0a55fc7655b5d6ce991660dc8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#af66f4eb0a55fc7655b5d6ce991660dc8">SI5324_N3_MIN</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:af66f4eb0a55fc7655b5d6ce991660dc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum N3n setting.  <a href="#af66f4eb0a55fc7655b5d6ce991660dc8">More...</a><br /></td></tr>
<tr class="separator:af66f4eb0a55fc7655b5d6ce991660dc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28f9a58a114f115759c45d759008a97e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a28f9a58a114f115759c45d759008a97e">SI5324_N3_MAX</a>&#160;&#160;&#160;0x080000</td></tr>
<tr class="memdesc:a28f9a58a114f115759c45d759008a97e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum N3n setting.  <a href="#a28f9a58a114f115759c45d759008a97e">More...</a><br /></td></tr>
<tr class="separator:a28f9a58a114f115759c45d759008a97e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a185d22bffe298f0a1a702769d154e5a1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a185d22bffe298f0a1a702769d154e5a1">Si5324_Init</a> (u32 IICBaseAddress, u8 IICAddress)</td></tr>
<tr class="memdesc:a185d22bffe298f0a1a702769d154e5a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the SiliconLabs Si5324 clock generator.  <a href="#a185d22bffe298f0a1a702769d154e5a1">More...</a><br /></td></tr>
<tr class="separator:a185d22bffe298f0a1a702769d154e5a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fe598dcb0d500c012afc7970117f5ed"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si5324drv_8h.html#a5fe598dcb0d500c012afc7970117f5ed">Si5324_SetClock</a> (u32 IICBaseAddress, u8 IICAddress, u8 ClkSrc, u32 ClkInFreq, u32 ClkOutFreq)</td></tr>
<tr class="memdesc:a5fe598dcb0d500c012afc7970117f5ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the output frequency.  <a href="#a5fe598dcb0d500c012afc7970117f5ed">More...</a><br /></td></tr>
<tr class="separator:a5fe598dcb0d500c012afc7970117f5ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a2db6980ae01d5ddad9a49d3251516feb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2db6980ae01d5ddad9a49d3251516feb">&#9670;&nbsp;</a></span>SI5324_CLKSRC_CLK1</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_CLKSRC_CLK1&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The following constants define the clock input select values. </p>
<p>Use clock input 1 </p>

<p class="reference">Referenced by <a class="el" href="xhdmi__example_8c.html#a13f636ef2d93d7ee10e421e5f604a510">I2cClk()</a>, and <a class="el" href="si5324drv_8h.html#a5fe598dcb0d500c012afc7970117f5ed">Si5324_SetClock()</a>.</p>

</div>
</div>
<a id="a02493d2265012108f5e0d4b80b199c76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02493d2265012108f5e0d4b80b199c76">&#9670;&nbsp;</a></span>SI5324_CLKSRC_CLK2</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_CLKSRC_CLK2&#160;&#160;&#160;2</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Use clock input 2. </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8h.html#a5fe598dcb0d500c012afc7970117f5ed">Si5324_SetClock()</a>.</p>

</div>
</div>
<a id="aa1d51e9b1e4b660eee4ec41222751c1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1d51e9b1e4b660eee4ec41222751c1e">&#9670;&nbsp;</a></span>SI5324_CLKSRC_XTAL</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_CLKSRC_XTAL&#160;&#160;&#160;3</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Use crystal (free running mode) </p>

<p class="reference">Referenced by <a class="el" href="xhdmi__example_8c.html#a13f636ef2d93d7ee10e421e5f604a510">I2cClk()</a>, and <a class="el" href="si5324drv_8h.html#a5fe598dcb0d500c012afc7970117f5ed">Si5324_SetClock()</a>.</p>

</div>
</div>
<a id="aa7a50734f0226414ddcb1e1c30815f20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7a50734f0226414ddcb1e1c30815f20">&#9670;&nbsp;</a></span>SI5324_DEBUG</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_DEBUG&#160;&#160;&#160;FALSE</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Debug output enable. </p>
<p>Set to TRUE to enable debug prints, to FALSE to disable debug prints. </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8c.html#a646751e6239e3401140c8c2a61c760a6">Si5324_DoSettings()</a>, <a class="el" href="si5324drv_8c.html#a80fcbb47ed73a63de3c6ce58d7cd2398">Si5324_FindN2()</a>, <a class="el" href="si5324drv_8c.html#a372fa6209b36e5fdb84df6141eed682f">Si5324_FindN2ls()</a>, <a class="el" href="si5324drv_8c.html#a821e65d96eee95550e5c2b2b393b0ee1">Si5324_FindNcls()</a>, <a class="el" href="si5324drv_8h.html#a185d22bffe298f0a1a702769d154e5a1">Si5324_Init()</a>, <a class="el" href="si5324drv_8c.html#af9e636114c299d13030d4959417c70e6">Si5324_Reset()</a>, and <a class="el" href="si5324drv_8h.html#a5fe598dcb0d500c012afc7970117f5ed">Si5324_SetClock()</a>.</p>

</div>
</div>
<a id="a8e4d865d04b23e830daa8be2e35a0922"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e4d865d04b23e830daa8be2e35a0922">&#9670;&nbsp;</a></span>SI5324_ERR_FREQ</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_ERR_FREQ&#160;&#160;&#160;-2</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Could not calculate frequency setting. </p>

</div>
</div>
<a id="a9ede2c0617ef9093ee69e3c5a01199f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ede2c0617ef9093ee69e3c5a01199f8">&#9670;&nbsp;</a></span>SI5324_ERR_IIC</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_ERR_IIC&#160;&#160;&#160;-1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>IIC error occurred. </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8c.html#a646751e6239e3401140c8c2a61c760a6">Si5324_DoSettings()</a>, and <a class="el" href="si5324drv_8c.html#af9e636114c299d13030d4959417c70e6">Si5324_Reset()</a>.</p>

</div>
</div>
<a id="a5fa75e494c0f242ce3a8d43680ec5b25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fa75e494c0f242ce3a8d43680ec5b25">&#9670;&nbsp;</a></span>SI5324_ERR_PARM</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_ERR_PARM&#160;&#160;&#160;-3</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Invalid parameter. </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8c.html#a646751e6239e3401140c8c2a61c760a6">Si5324_DoSettings()</a>, and <a class="el" href="si5324drv_8h.html#a5fe598dcb0d500c012afc7970117f5ed">Si5324_SetClock()</a>.</p>

</div>
</div>
<a id="a228ebaa351cbbfc0f6c5c94554d7ca4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a228ebaa351cbbfc0f6c5c94554d7ca4e">&#9670;&nbsp;</a></span>SI5324_F3_MAX</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_F3_MAX&#160;&#160;&#160;2000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum phase detector frequency. </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8c.html#a9d9c096a3379e1a3e168b33f7d0c27f2">Si5324_CalcFreqSettings()</a>, and <a class="el" href="si5324drv_8c.html#a80fcbb47ed73a63de3c6ce58d7cd2398">Si5324_FindN2()</a>.</p>

</div>
</div>
<a id="aa37b2b306f750c592c636849367b5987"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa37b2b306f750c592c636849367b5987">&#9670;&nbsp;</a></span>SI5324_FIN_MAX</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_FIN_MAX&#160;&#160;&#160;710000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum input frequency. </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8h.html#a5fe598dcb0d500c012afc7970117f5ed">Si5324_SetClock()</a>.</p>

</div>
</div>
<a id="a81ac3490c0ed20fabfa1b71584eac04b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81ac3490c0ed20fabfa1b71584eac04b">&#9670;&nbsp;</a></span>SI5324_FIN_MIN</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_FIN_MIN&#160;&#160;&#160;2000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Minimum input frequency. </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8h.html#a5fe598dcb0d500c012afc7970117f5ed">Si5324_SetClock()</a>.</p>

</div>
</div>
<a id="a0883e98bf3d4a3ce4e051b598212fe1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0883e98bf3d4a3ce4e051b598212fe1e">&#9670;&nbsp;</a></span>SI5324_FOSC_MAX</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_FOSC_MAX&#160;&#160;&#160;5670000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum oscillator frequency. </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8c.html#a9d9c096a3379e1a3e168b33f7d0c27f2">Si5324_CalcFreqSettings()</a>.</p>

</div>
</div>
<a id="a8adf10a1b80feb2992f6b971cdd28271"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8adf10a1b80feb2992f6b971cdd28271">&#9670;&nbsp;</a></span>SI5324_FOSC_MIN</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_FOSC_MIN&#160;&#160;&#160;4850000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The following constants define the limits of the Si5324 frequencies. </p>
<p>Minimum oscillator frequency </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8c.html#a9d9c096a3379e1a3e168b33f7d0c27f2">Si5324_CalcFreqSettings()</a>.</p>

</div>
</div>
<a id="ae6cb6ad9a6bdd28badfa7d4dbd404b89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6cb6ad9a6bdd28badfa7d4dbd404b89">&#9670;&nbsp;</a></span>SI5324_FOUT_MAX</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_FOUT_MAX&#160;&#160;&#160;945000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum output frequency. </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8h.html#a5fe598dcb0d500c012afc7970117f5ed">Si5324_SetClock()</a>.</p>

</div>
</div>
<a id="ad6256033a0e61e3af40ff9d7cb420639"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6256033a0e61e3af40ff9d7cb420639">&#9670;&nbsp;</a></span>SI5324_FOUT_MIN</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_FOUT_MIN&#160;&#160;&#160;2000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Minimum output frequency. </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8h.html#a5fe598dcb0d500c012afc7970117f5ed">Si5324_SetClock()</a>.</p>

</div>
</div>
<a id="aca2c63c7a287455eff6d20da1772484e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca2c63c7a287455eff6d20da1772484e">&#9670;&nbsp;</a></span>SI5324_N1_HS_MAX</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_N1_HS_MAX&#160;&#160;&#160;11</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum N1_HS setting. </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8c.html#a9d9c096a3379e1a3e168b33f7d0c27f2">Si5324_CalcFreqSettings()</a>.</p>

</div>
</div>
<a id="a3d32f6e4587dbcf01bc3a2c2e91a2df7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d32f6e4587dbcf01bc3a2c2e91a2df7">&#9670;&nbsp;</a></span>SI5324_N1_HS_MIN</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_N1_HS_MIN&#160;&#160;&#160;6</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The following constants define the limits of the divider settings. </p>
<p>Minimum N1_HS setting (4 and 5 are for higher output frequencies than we support </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8c.html#a9d9c096a3379e1a3e168b33f7d0c27f2">Si5324_CalcFreqSettings()</a>.</p>

</div>
</div>
<a id="a8c09138972a1acb59eb46de878c97a3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c09138972a1acb59eb46de878c97a3a">&#9670;&nbsp;</a></span>SI5324_N2_HS_MAX</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_N2_HS_MAX&#160;&#160;&#160;11</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum NC2_HS setting. </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8c.html#a80fcbb47ed73a63de3c6ce58d7cd2398">Si5324_FindN2()</a>.</p>

</div>
</div>
<a id="a33d91ebd8ce05be9f823fc82e35a5d38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33d91ebd8ce05be9f823fc82e35a5d38">&#9670;&nbsp;</a></span>SI5324_N2_HS_MIN</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_N2_HS_MIN&#160;&#160;&#160;4</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Minimum NC2_HS setting. </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8c.html#a80fcbb47ed73a63de3c6ce58d7cd2398">Si5324_FindN2()</a>.</p>

</div>
</div>
<a id="aad9917dc2207eddbbe18ac7e14050133"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad9917dc2207eddbbe18ac7e14050133">&#9670;&nbsp;</a></span>SI5324_N2_LS_MAX</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_N2_LS_MAX&#160;&#160;&#160;0x100000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum NC2_LS setting (even values only) </p>

</div>
</div>
<a id="a59663975c6b419aae6b34f3ef265605e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59663975c6b419aae6b34f3ef265605e">&#9670;&nbsp;</a></span>SI5324_N2_LS_MIN</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_N2_LS_MIN&#160;&#160;&#160;2</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Minimum NC2_LS setting (even values only) </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8c.html#a80fcbb47ed73a63de3c6ce58d7cd2398">Si5324_FindN2()</a>.</p>

</div>
</div>
<a id="a28f9a58a114f115759c45d759008a97e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28f9a58a114f115759c45d759008a97e">&#9670;&nbsp;</a></span>SI5324_N3_MAX</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_N3_MAX&#160;&#160;&#160;0x080000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum N3n setting. </p>

</div>
</div>
<a id="af66f4eb0a55fc7655b5d6ce991660dc8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af66f4eb0a55fc7655b5d6ce991660dc8">&#9670;&nbsp;</a></span>SI5324_N3_MIN</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_N3_MIN&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Minimum N3n setting. </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8c.html#a9d9c096a3379e1a3e168b33f7d0c27f2">Si5324_CalcFreqSettings()</a>.</p>

</div>
</div>
<a id="a1970bf7864d31f729e163d103a903075"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1970bf7864d31f729e163d103a903075">&#9670;&nbsp;</a></span>SI5324_NC_LS_MAX</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_NC_LS_MAX&#160;&#160;&#160;0x100000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum NCn_LS setting (1 and even values) </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8c.html#a9d9c096a3379e1a3e168b33f7d0c27f2">Si5324_CalcFreqSettings()</a>, and <a class="el" href="si5324drv_8c.html#a756bafb27288aa8cf3100c14800d9a4e">Si5324_CalcNclsLimits()</a>.</p>

</div>
</div>
<a id="a69fe20269cf003fdcf22f5fc1cd2769c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69fe20269cf003fdcf22f5fc1cd2769c">&#9670;&nbsp;</a></span>SI5324_NC_LS_MIN</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_NC_LS_MIN&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Minimum NCn_LS setting (1 and even values) </p>

<p class="reference">Referenced by <a class="el" href="si5324drv_8c.html#a9d9c096a3379e1a3e168b33f7d0c27f2">Si5324_CalcFreqSettings()</a>, and <a class="el" href="si5324drv_8c.html#a756bafb27288aa8cf3100c14800d9a4e">Si5324_CalcNclsLimits()</a>.</p>

</div>
</div>
<a id="ab111a2a2d52eb8e3366d8c5723a186a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab111a2a2d52eb8e3366d8c5723a186a8">&#9670;&nbsp;</a></span>SI5324_SUCCESS</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_SUCCESS&#160;&#160;&#160;0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The following constants are error codes generated by the functions in this driver. </p>
<p>Operation was successful </p>

<p class="reference">Referenced by <a class="el" href="xhdmi__example_8c.html#a13f636ef2d93d7ee10e421e5f604a510">I2cClk()</a>, <a class="el" href="si5324drv_8c.html#a646751e6239e3401140c8c2a61c760a6">Si5324_DoSettings()</a>, <a class="el" href="si5324drv_8c.html#af9e636114c299d13030d4959417c70e6">Si5324_Reset()</a>, and <a class="el" href="si5324drv_8h.html#a5fe598dcb0d500c012afc7970117f5ed">Si5324_SetClock()</a>.</p>

</div>
</div>
<a id="aba0c6a06cbada8a7b750be6ff0695a47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba0c6a06cbada8a7b750be6ff0695a47">&#9670;&nbsp;</a></span>SI5324_XTAL_FREQ</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI5324_XTAL_FREQ&#160;&#160;&#160;114285000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The frequency of the crystal connected to the XA/XB pins of the Si5324 in Hz. </p>

<p class="reference">Referenced by <a class="el" href="xhdmi__example_8c.html#a13f636ef2d93d7ee10e421e5f604a510">I2cClk()</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a185d22bffe298f0a1a702769d154e5a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a185d22bffe298f0a1a702769d154e5a1">&#9670;&nbsp;</a></span>Si5324_Init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Si5324_Init </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>IICBaseAddress</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>IICAddress</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize the SiliconLabs Si5324 clock generator. </p>
<p>After initialization, the clock generator is not generating a clock yet. Call si5324_set_clock to start the clock generator.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">IICBaseAddress</td><td>contains the base address of the IIC master device. </td></tr>
    <tr><td class="paramname">IICAddress</td><td>contains the 7 bit IIC address of the Si5324 device.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SI5324_SUCCESS for success, SI5324_ERR_IIC for IIC access failure. </dd></dl>

<p class="reference">References <a class="el" href="si5324drv_8h.html#aa7a50734f0226414ddcb1e1c30815f20">SI5324_DEBUG</a>, <a class="el" href="si5324drv_8c.html#a20b8835416e6bdb5d4c48e1ded4279c3">SI5324_DEFAULTS</a>, and <a class="el" href="si5324drv_8c.html#a646751e6239e3401140c8c2a61c760a6">Si5324_DoSettings()</a>.</p>

</div>
</div>
<a id="a5fe598dcb0d500c012afc7970117f5ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fe598dcb0d500c012afc7970117f5ed">&#9670;&nbsp;</a></span>Si5324_SetClock()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Si5324_SetClock </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>IICBaseAddress</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>IICAddress</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>ClkSrc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>ClkInFreq</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>ClkOutFreq</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the output frequency. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">IICBaseAddress</td><td>contains the base address of the IIC master device. </td></tr>
    <tr><td class="paramname">IICAddress</td><td>contains the 7 bit IIC address of the Si5324 device. </td></tr>
    <tr><td class="paramname">ClkSrc</td><td>selects the clock input to use. </td></tr>
    <tr><td class="paramname">ClkInFreq</td><td>contains the frequency of the input clock. </td></tr>
    <tr><td class="paramname">ClkOutFreq</td><td>contains the desired output clock frequency</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SI5324_SUCCESS for success, SI5324_ERR_IIC for IIC access failure, SI5324_ERR_FREQ when the requested frequency cannot be generated.</dd></dl>
<p>Set the output frequency.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">IICBaseAddress</td><td>contains the base address of the IIC master device. </td></tr>
    <tr><td class="paramname">IICAddress</td><td>contains the 7 bit IIC address of the Si5324 device. </td></tr>
    <tr><td class="paramname">ClkSrc</td><td>selects the clock input to use. </td></tr>
    <tr><td class="paramname">ClkInFreq</td><td>contains the frequency of the input clock (2kHz-710MHz). </td></tr>
    <tr><td class="paramname">ClkOutFreq</td><td>contains the desired output clock frequency (2kHz-945MHz).</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SI5324_SUCCESS for success, SI5324_ERR_IIC for IIC access failure, SI5324_ERR_FREQ when the requested frequency cannot be generated, SI5324_ERR_PARM when the ClkSrc or ClkDest parameters are invalid or the ClkInFreq or ClkOutFreq are out of range. </dd></dl>

<p class="reference">References <a class="el" href="si5324drv_8c.html#a9d9c096a3379e1a3e168b33f7d0c27f2">Si5324_CalcFreqSettings()</a>, <a class="el" href="si5324drv_8h.html#a2db6980ae01d5ddad9a49d3251516feb">SI5324_CLKSRC_CLK1</a>, <a class="el" href="si5324drv_8h.html#a02493d2265012108f5e0d4b80b199c76">SI5324_CLKSRC_CLK2</a>, <a class="el" href="si5324drv_8h.html#aa1d51e9b1e4b660eee4ec41222751c1e">SI5324_CLKSRC_XTAL</a>, <a class="el" href="si5324drv_8h.html#aa7a50734f0226414ddcb1e1c30815f20">SI5324_DEBUG</a>, <a class="el" href="si5324drv_8c.html#a646751e6239e3401140c8c2a61c760a6">Si5324_DoSettings()</a>, <a class="el" href="si5324drv_8h.html#a5fa75e494c0f242ce3a8d43680ec5b25">SI5324_ERR_PARM</a>, <a class="el" href="si5324drv_8h.html#aa37b2b306f750c592c636849367b5987">SI5324_FIN_MAX</a>, <a class="el" href="si5324drv_8h.html#a81ac3490c0ed20fabfa1b71584eac04b">SI5324_FIN_MIN</a>, <a class="el" href="si5324drv_8h.html#ae6cb6ad9a6bdd28badfa7d4dbd404b89">SI5324_FOUT_MAX</a>, <a class="el" href="si5324drv_8h.html#ad6256033a0e61e3af40ff9d7cb420639">SI5324_FOUT_MIN</a>, and <a class="el" href="si5324drv_8h.html#ab111a2a2d52eb8e3366d8c5723a186a8">SI5324_SUCCESS</a>.</p>

<p class="reference">Referenced by <a class="el" href="xhdmi__example_8c.html#a13f636ef2d93d7ee10e421e5f604a510">I2cClk()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
